home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / latex / base / install.txt < prev    next >
Text File  |  1994-12-17  |  16KB  |  469 lines
  1.                         LaTeX Installation Guide
  2.  
  3.                            21 November 1994
  4.  
  5. SUMMARY
  6. =======
  7.  
  8. This file contains the installation instructions for the latest
  9. version of the LaTeX document preparation system.
  10.  
  11. The rest of this document describes:
  12.  
  13.  * How to find out about installing LaTeX for your version of TeX.
  14.  
  15.  * How the installation works.
  16.  
  17.  * What to do if anything goes wrong.
  18.  
  19. TeX experts who want to know more about how the LaTeX installation 
  20. works and how it can be customized may like to read texpert.txt.
  21.  
  22.  
  23. DOCUMENTATION
  24. =============
  25.  
  26. Brief introductions to various aspects of the new LaTeX release can be
  27. found in the distributed files with names <*>guide.tex.  You will need
  28. to install the new version before you can typeset these files.
  29.  
  30. A full description of the new LaTeX release (and of more than 100
  31. packages that can be used with LaTeX) can be found in:
  32.  
  33.  * The LaTeX Companion, Goossens, Mittelbach and Samarin, Addison-Wesley
  34.    ISBN 0-201-54199-8.
  35.  
  36. The new release is also described in the second edition of:
  37.  
  38.  * LaTeX A Document Preparation System, Leslie Lamport, Addison-Wesley
  39.  
  40.  
  41. REQUIREMENTS
  42. ============
  43.  
  44. In addition to the LaTeX distribution files, you will also need the
  45. following:
  46.  
  47.  * a TeX system, including iniTeX (see `Your Version of TeX', below);
  48.  
  49.  * the file `hyphen.tex', or some other hyphenation files (see `Creating
  50.    the LaTeX Format', below);
  51.  
  52.  * the font files (normally .tfm files) for the Computer Modern fonts,
  53.    including some non-standard ones (see `Fonts needed', below).
  54.  
  55.  
  56. YOUR VERSION OF TEX
  57. ===================
  58.  
  59. LaTeX is based upon Donald Knuth's TeX typesetting system.  This is 
  60. available for almost every make of computer, from microcomputers
  61. through workstations to large main-frames.  
  62.  
  63. Further details about how to install LaTeX for your version of TeX may
  64. be available in a file called <system>.txt.  At present the following
  65. such files exist (at least):
  66.  
  67.  * decustex.txt for TeX from DECUS on VAX/VMS.
  68.  
  69.  * directex.txt for DirectTeX on the Macintosh.
  70.  
  71.  * emtex.txt for emTeX on IBM PC compatibles.
  72.  
  73.  * microtex.txt for MicroTeX (uTeX) on IBM PC compatibles. 
  74.  
  75.  * oztex.txt for OzTeX on the Macintosh.
  76.  
  77.  * pastex.txt for PasTeX on the Amiga.
  78.  
  79.  * pctex.txt for PCTeX on IBM PC compatibles.
  80.  
  81.  * textures.txt for Textures on the Macintosh.
  82.  
  83.  * web2ctex.txt for web2c TeX on Unix platforms.
  84.  
  85.  * yandytex.txt for Y&YTeX on IBM PC compatibles. 
  86.  
  87. You should finish reading this file before reading the <system>.txt
  88. file for your version.  If there is no such file then this file alone is
  89. your installation guide.
  90.  
  91. If you have bought a commercial version of TeX/LaTeX and there is no
  92. file for your system then you could ask the company which sells your
  93. version of TeX to supply one.
  94.  
  95. Note to TeX implementors/suppliers:
  96. ----------------------------------
  97. If you can supply us with a <system>.txt file for your implementation
  98. we shall be very grateful and we shall add it to our distribution.
  99.  
  100.  
  101.  
  102. HOW THE INSTALLATION WORKS
  103. ==========================
  104.  
  105. The LaTeX installation is in five stages:
  106.  
  107.  * Saving any old version of LaTeX.
  108.  
  109.  * Unpacking the distribution (this may not be necessary).
  110.  
  111.  * Creating the LaTeX format.
  112.  
  113.  * Putting the files where LaTeX can read them.
  114.  
  115.  * Checking the installation.
  116.  
  117.  
  118. SAVING YOUR OLD VERSION OF LaTeX
  119. ================================
  120.  
  121. If you are currently using the old LaTeX version, 2.09, you may wish
  122. to save it before installing the new version of LaTeX.
  123.  
  124. If it exists, the <system>.txt file will describe in detail how to do
  125. this; in some of these files, the new version is referred to as
  126. LaTeX2e in order to clearly distinguish it from the old version.
  127.  
  128. The details of how to do everything in this section will depend to a
  129. very large extent on your TeX implementation.
  130.  
  131. First you should find the LaTeX format file on your system
  132. (usually called `latex.fmt' or `lplain.fmt') and rename it to
  133. `latex209.fmt'.
  134.  
  135. You should then save a copy of the current  LaTeX system files.  These
  136. may be kept in a TeX inputs directory or folder, which is usually
  137. called something like one of these:
  138.  
  139.    tex\texinput  tex/inputs  TeX-inputs
  140.  
  141. or they may be kept in a separate LaTeX inputs location, possibly a
  142. subdirectory or subfolder of the TeX inputs location, called `latex'.
  143.    
  144. There are thus two possibilities, depending on whether the LaTeX
  145. inputs have been kept separate from the other TeX inputs or not.
  146.  
  147.  * If the LaTeX inputs are separated from the other TeX inputs, then
  148.    you should make a new directory that is a copy of the whole of the
  149.    LaTeX inputs directory, and call it `latex209'.
  150.    
  151.  * If the LaTeX inputs are kept with the other TeX inputs, then you 
  152.    should create a new directory called `latex209' and then copy to it
  153.    any file ending with .sty from the LaTeX inputs directory.
  154.    
  155. It may be possible to run both the new LaTeX and LaTeX 2.09 in
  156. parallel.  To do this, you should create a `latex209' command,
  157. or menu entry, that is similar to `latex' except that:
  158.  
  159.  * The `latex209' format is used rather than `latex'.
  160.  
  161.  * The `latex209' directory is searched before the LaTeX inputs
  162.    directory.
  163.  
  164. The details of how to do this vary according to your system so you
  165. may find more information in a <system>.txt file.
  166.  
  167.  
  168. BEFORE UNPACKING THE DISTRIBUTION
  169. =================================
  170.  
  171. Latex needs a number of files to run, for example `article.cls'
  172. contains the `article' document class.  However, these files are NOT
  173. themselves the source files produced by the LaTeX3 Project Team.  We
  174. write documented sources in `docstrip archive files' which can be
  175. unpacked to produce the files that LaTeX needs. For example,
  176. classes.dtx contains the documented sources for all the LaTeX
  177. document classes, including article.cls.
  178.  
  179. The FIRST thing to do is to check whether you need to unpack these
  180. archive files, as follows.
  181.  
  182. Before reading any further, you should check to see whether the LaTeX
  183. distribution you have contains the unpacked files.  You can do this by
  184. looking to see if you have got the file latex.ltx.  If you do, then
  185. you should have all the unpacked files and so you can move on to the
  186. section entitled `Creating the LaTeX format'.
  187.  
  188. The unpacking will create and write files only into the current
  189. directory (or current folder, or default directory).  This helps to
  190. prevent it overwriting existing files or causing problems with your
  191. system files.  It is therefore sensible to carry out the installation
  192. in a directory reserved for this purpose; on a multi-user system you
  193. should ensure that you have read and write permissions for files in
  194. this directory.
  195.  
  196.  
  197. UNPACKING THE DISTRIBUTION
  198. ==========================
  199.  
  200. The archive files are unpacked by running iniTeX on the file 
  201. unpack.ins.
  202.  
  203. NOTE: On relatively slow computers, this unpacking can take a long
  204. time.  On a Macintosh SE it takes about 3 hours.  On a Macintosh
  205. Duo 230 or a 12MHz 80286 PC it takes about 30 minutes.  On a moderately
  206. busy SparcStation 10 or a fast 80486 PC it takes about 5 minutes.
  207.  
  208.  
  209. CREATING THE LATEX FORMAT
  210. =========================
  211.  
  212. To create the LaTeX format, you should run iniTeX on the file
  213. `latex.ltx'.  
  214.  
  215. A hyphenation file such as `hyphen.tex' is read by this run so it
  216. should be accessible by iniTeX.  It also needs to be able to read the
  217. `.tfm' font files for the basic fonts.  These font files and
  218. hyphenation file(s) should be part of your TeX system.
  219.  
  220. You should save the resulting format file `latex.fmt' in the TeX
  221. formats directory.  You may also have to create and/or install a
  222. program called `latex', a `LaTeX' option to your TeX implementation,
  223. or a batch file or shell script.  The details of this stage will
  224. depend on your TeX implementation; note that the name of the format
  225. file differs from that normally used in LaTeX 2.09.
  226.  
  227. Note: TeX experts may wish to customize LaTeX (for example, to allow 
  228. non-American hyphenation).  They should read texpert.txt to find out 
  229. how to do this.
  230.  
  231.  
  232. PUTTING THE FILES WHERE LaTeX CAN READ THEM
  233. ===========================================
  234.  
  235. The next step in the installation of LaTeX is to move the files needed
  236. to run the system into the correct directories (or folders).
  237. These are:
  238.  
  239.  * the directory containing the format files.
  240.  
  241.  * the LaTeX inputs directory, which contains LaTeX system files.
  242.  
  243.  * the MakeIndex inputs directory, which contains MakeIndex files.
  244.  
  245. You should move to the formats directory:
  246.  
  247.  * latex.fmt.
  248.  
  249. You should move to the LaTeX input directory the files:
  250.  
  251.  * latexbug.tex, testpage.tex, lablst.tex, idx.tex, nfssfont.tex 
  252.    small2e.tex, sample2e.tex and docstrip.tex.
  253.  
  254. and any files whose name ends with:
  255.  
  256.  * .cls,  document class files.
  257.  
  258.  * .clo,  document class options files.
  259.  
  260.  * .sty,  package files.
  261.  
  262.  * .fd,   font definition files.
  263.  
  264.  * .def,  files of definitions which may be read by LaTeX while
  265.           processing documents.
  266.  
  267.  * .cfg,  TeX expert configuration files.
  268.  
  269. You should move to the MakeIndex input directory all files
  270. whose name ends with:
  271.  
  272.  * .ist,  MakeIndex style files.
  273.  
  274. You have now installed LaTeX!
  275.  
  276.  
  277. GETTING A WORKING LaTeX
  278. =======================
  279.  
  280. You may now need to set up your system to use the new version of
  281. LaTeX; e.g. by configuring the environment, adding menu items, writing
  282. batch files or shell scripts.  Details may be found in a <system>.txt
  283. file for your system.
  284.  
  285.  
  286. CHECKING THAT THE INSTALLATION WORKED
  287. =====================================
  288.  
  289. To make sure that the installation has worked, you should run the new 
  290. LaTeX on the document `ltxcheck.tex'.  
  291.  
  292. How this is done varies according to your system; you may find the
  293. necessary detailed instructions in a <system>.txt file.
  294.  
  295. This will produce a number of messages, each of which should be `OK'.
  296. If any of them are `BAD', then read the `PROBLEMS' section below.
  297.  
  298. If all the messages are `OK' then you are finished!
  299.  
  300. Fonts needed
  301. ------------
  302.  
  303. One thing that is checked by running ltxcheck.tex is the existence of
  304. certain fonts on your system.  
  305.  
  306. The new LaTeX format assumes that you have on your system more font
  307. files from the Computer Modern families than did previous versions.
  308.  
  309. It is not essential to get all these fonts immediately but, if you do
  310. not have the .tfm files for some of them fonts then you will get
  311. several error messages when you try to typeset any of the
  312. documentation files, such as `usrguide.tex'.
  313. Here are some examples:
  314.  
  315.   ! Font OML/cmm/b/it/8=cmmib8 at 8.0pt not loadable:
  316.                                         Metric (TFM) file not found
  317.  
  318.   ! Font OMS/cmsy/b/n/8=cmbsy8 at 8.0pt not loadable:
  319.                                         Metric (TFM) file not found
  320.  
  321. You can, in fact, ignore all these messages (however awful they may
  322. sound) as far as typesetting the file is concerned: the results,
  323. whilst not perfect, will be little different to what was intended.
  324.  
  325. However, you should install these fonts as soon as possible (they are
  326. in the sub-directory `fonts/tfm' of the LaTeX directory on CTAN).  
  327. They are:
  328.  
  329.    cmmib5   cmmib6   cmmib7   cmmib8  cmmib9
  330.    cmbsy5   cmbsy6   cmbsy7   cmbsy8  cmbsy9
  331.  
  332.    
  333. PROBLEMS
  334. ========
  335.  
  336. On most systems the installation should proceed smoothly.  However, you
  337. may get some errors.
  338.  
  339.  
  340. `texsys.cfg':  While running iniTeX on latex.ltx you may get an error
  341.    message that reports a problem with texsys.cfg.  
  342.  
  343.    If this happens then you have obtained (or produced) a texsys.cfg
  344.    file that is not suitable for your system.  
  345.    
  346.    First, if it exists read the <system>.txt file.  This may tell you
  347.    how to customize the file texsys.cfg.
  348.    
  349.    If the <system>.txt file does not mention texsys.cfg then you should 
  350.    not need a texsys.cfg file.  Try deleting texsys.cfg and building the
  351.    LaTeX format again.
  352.    
  353.    If you still get errors, try using LaTeX to typeset ltdirchk.dtx and 
  354.    then read this document.
  355.  
  356.  The details of how to do this vary according to your system so you
  357. may find more details in a <system>.txt file.
  358.  
  359.  
  360. `File missing': Some of the files from the LaTeX distribution are
  361.    missing.  There are a number of possible reasons for this:
  362.  
  363.    * The files really are missing.
  364.      You should get the missing files from the same place you got the
  365.      rest of the distribution.  If you cannot do this then you should
  366.      complain to whoever gave you this distribution.
  367.  
  368.    * The files are present, but in the wrong directory.
  369.      You should move the files to a directory that iniTeX can read.
  370.  
  371.    * The files are present, and in the right directory.
  372.      Your iniTeX may have been set up incorrectly.  You may be able to
  373.      correct this, depending on your TeX implementation.  See the
  374.      documentation of your TeX implementation for more details.
  375.  
  376.  
  377. `Font missing': Some of the fonts (.tfm files) required by LaTeX are
  378.    missing.  As above, either you have not got the required files, or
  379.    iniTeX is not able to find them.  So you may need to move them or to
  380.    configure iniTeX to look in the correct places.  See the
  381.    documentation of your TeX implementation for more details.
  382.  
  383.  
  384. `Out of memory': On TeX implementations with small memory, you may
  385.    exhaust iniTeX's memory whilst installing LaTeX.
  386.  
  387.    You may be able to correct this:
  388.  
  389.    * Some TeX implementations allow the amount of memory allocated
  390.      to TeX to be increased.  See the documentation of your TeX
  391.      implementation for more details.
  392.  
  393.    * Some iniTeX implementations allow more memory than others; so
  394.      you may be able to run iniTeX on a larger machine and then move
  395.      the files across to the smaller machine.
  396.  
  397.    * If the error happens during the unpacking of the distribution
  398.      (i.e. when you run iniTeX on unpack.ins) then try running this
  399.      file with normal TeX, for example plain TeX or an old version
  400.      of LaTeX.
  401.  
  402.  
  403. If you have any problems installing LaTeX, you should:
  404.  
  405.  * read the <system>.txt file, if one exists;
  406.  
  407.  * if this does not help, ask your local TeX guru;
  408.  
  409.  * if this fails, try asking a local TeX mailing list;
  410.  
  411.  * if this fails, run iniTeX on the file latexbug.tex, fill in the
  412.    resulting bug report form, and send to the address given in that
  413.    file.
  414.  
  415.  
  416. CLEARING UP
  417. ===========
  418.  
  419. You may now be wondering what to do with all the remaining files
  420. that are not needed to run LaTeX.  This is, of course, a matter of
  421. personal taste and availability of disk space but here is some
  422. guidance.
  423.  
  424.  * The files with extension .dtx, together with source2e.tex,
  425.    can be used to typeset the documented source code (see texpert.txt
  426.    for further information).
  427.  
  428.  * The files with extension .fdd contain the documented sources for
  429.    the font defintion files. 
  430.  
  431.  * The files ltnews<xx>.tex and ltnews<xx>.ps both contain the latest 
  432.    LaTeX newsletter.
  433.  
  434.  * The files with extension .txt contain information about (amongst
  435.    other things) copyright, installation, patches and bug-reports; and
  436.    those with extension .err contain errata lists for various
  437.    publications: see 00readme.txt for further details. 
  438.  
  439.  * The files with names of the form <xxx>guide.tex contain reference 
  440.    information covering only those features new to this version of
  441.    LaTeX: they are not intended to be either a user guide or a
  442.    complete reference.   
  443.  
  444.  * The files with extension .ltx, together with latexcheck.tex, 
  445.    are used to create and test the format; therefore you should 
  446.    keep these if you expect to remake the format before getting 
  447.    the next full distribution. 
  448.  
  449.  * The files with extension .ins are used to unpack the code from the
  450.    .dtx and .fdd files.
  451.  
  452.  * We recommend that you keep, in the formats directory, the
  453.    transcript file that was produced whilst creating the format; 
  454.    this file is called latex.log or latex.lis.
  455.    
  456.   
  457. FINALLY
  458. =======
  459.  
  460. Once you have installed LaTeX for your TeX implementation, you might
  461. like to write a <system>.txt file explaining how you did it.  If you
  462. want to do this, you should edit the file template.txt.
  463.  
  464. If you would like your <system>.txt file to be included with the LaTeX
  465. distribution, please mail it to the above address.
  466.  
  467.  
  468. --- Copyright 1994 the LaTeX3 project.  All rights reserved ---
  469.